package com.simple.quartz.service;

import com.simple.common.exception.TaskException;
import com.simple.framework.core.domain.vo.PagingVo;
import com.simple.quartz.domain.dto.AddSysJobDto;
import com.simple.quartz.domain.dto.ChangeJobStatusDto;
import com.simple.quartz.domain.dto.ListSysJobDto;
import com.simple.quartz.domain.entity.SysJob;
import org.quartz.SchedulerException;

import java.util.Set;

/**
 * @Description 定时任务调度表(SysJob)表服务接口
 * @Author xiaoke
 * @Date 2024/8/19 19:51
 * @Version 1.0
 */
public interface SysJobService {

    /**
     * 分页查询定时任务调度表(SysJob)列表
     *
     * @param dto 查询条件
     * @return List<SysJob>
     */
    PagingVo<SysJob> list(ListSysJobDto dto);


    /**
     * 暂停任务
     *
     * @param job 调度信息
     * @return 结果
     */
    boolean pause(SysJob job) throws SchedulerException;

    /**
     * 恢复任务
     *
     * @param job 调度信息
     * @return 结果
     */
    boolean resume(SysJob job) throws SchedulerException;

    /**
     * 删除任务后，所对应的trigger也将被删除
     *
     * @param job 调度信息
     * @return 结果
     */
    boolean delete(SysJob job) throws SchedulerException;

    /**
     * 批量删除调度信息
     *
     * @param ids 需要删除的任务ID
     */
    void deleteJobByIds(Set<Long> ids) throws SchedulerException;

    /**
     * 任务调度状态修改
     *
     * @param id     任务Id
     * @param status 状态
     * @return boolean
     */
    Boolean changeStatus(Long id, ChangeJobStatusDto status) throws SchedulerException;

    /**
     * 立即运行任务
     *
     * @param id 任务id
     * @return 结果
     */
    boolean run(Long id) throws SchedulerException;

    /**
     * 新增任务
     *
     * @param dto 调度信息
     * @return 结果
     */
    Long insert(AddSysJobDto dto) throws SchedulerException, TaskException;

    /**
     * 更新任务
     *
     * @param id  任务ID
     * @param dto 调度信息
     */
    void update(Long id, AddSysJobDto dto) throws SchedulerException, TaskException;

    /**
     * 校验cron表达式是否有效
     *
     * @param cronExpression 表达式
     * @return 结果
     */
    boolean checkCronExpressionIsValid(String cronExpression);

}
